/*!
 * # 模块 Api 类:
 *  Op - 数据操作日志记录
 * 
 * # 描述:
 *  向 App 公开记录数据操作日志的方法，不对外公开服务。
 *  
 *  Copyright (c), 上海沃恩信息科技有限公司.
 *  All rights reserved.
 *  Licensed under BSD (https://www.pittypat.work/bsd.html).
 */

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Pittypat;

namespace Waln.Log.Op
{
	/// <summary>
	/// 提供对模块 数据操作日志记录 中功能的封装和调用。
	/// </summary>
	[global::Pittypat.Module(global::Pittypat.ModulePresentation.UI, AllowAnonymous = false)]
	public sealed class Api : global::Pittypat.Module
	{
		#region CreateAsync

		/// <summary>
		/// 创建一条新的数据操作日志记录。
		/// </summary>
		/// <param name="model">功能模型对象，其中包含了功能的参数列表、执行状态以及相关消息。</param>
		/// <param name="progress">跟踪和汇报异步操作的进度。</param>
		/// <returns>操作成功返回 消息 Id，否则返回 null。</returns>
		public async global::System.Threading.Tasks.Task<global::Pittypat.IJson> CreateAsync(
			global::Pittypat.FunctionModel<Args.Create> model, 
			global::Pittypat.IAsyncProgress progress)
		{
			// 执行数据操作
			await this.DataService.Exec(model, progress);

			// 如果操作成功，返回消息 Id
			return model.Success ? model.Args.Id : null;
		}

		#endregion

		#region DeleteAsync

		/// <summary>
		/// 删除一条数据操作日志消息，仅仅在当前会话范围内使用。
		/// </summary>
		/// <param name="model">功能模型对象，其中包含了功能的参数列表、执行状态以及相关消息。</param>
		/// <param name="progress">跟踪和汇报异步操作的进度。</param>
		/// <returns>没有输出参数，默认总是返回 null。</returns>
		public async global::System.Threading.Tasks.Task<global::Pittypat.IJson> DeleteAsync(
			global::Pittypat.FunctionModel<Args.Delete> model, 
			global::Pittypat.IAsyncProgress progress)
		{
			// 执行数据操作
			await this.DataService.Exec(model, progress);

			// model.Args 没有定义输出参数
			return null;
		}

		#endregion
	}
}
